/*
 * Copyright (c) 2023 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.helidon.common;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation marking this type as generated.
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Generated {
    /**
     * The code generator that generated this type.
     *
     * @return generator name
     */
    String value();

    /**
     * The type that caused this type to be generated.
     *
     * @return trigger for this type
     */
    String trigger();

    /**
     * Generator version.
     * This may be useful to maintain backward compatibility when analyzing types generated by an older version.
     *
     * @return version of the code generator, defaults to {@code 1}
     */
    String version() default "1";

    /**
     * Optional additional comments about this generated type.
     *
     * @return free text comments
     */
    String comments() default "";
}
